/*
 * Copyright Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags and
 * the COPYRIGHT.txt file distributed with this work.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 */
package org.teiid.query.processor.proc;

import org.teiid.client.plan.PlanNode;
import org.teiid.core.TeiidComponentException;
import org.teiid.language.SQLConstants;

public class ReturnInstruction extends ProgramInstruction {

    public ReturnInstruction() {
    }

    public String toString() {
        return SQLConstants.Reserved.RETURN;
    }

    public void process(ProcedurePlan env) throws TeiidComponentException {
        while(env.peek() != null){
            env.pop(true);
        }
    }

    public PlanNode getDescriptionProperties() {
        return new PlanNode(SQLConstants.Reserved.RETURN);
    }

}
